<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <title>OpenLayers v8.2.0 API - Module: ol/sphere</title>
    <script src="scripts/prettify/prettify.js"></script>
    <script src="scripts/prettify/lang-css.js"></script>
    <script src="https://code.jquery.com/jquery-3.6.0.min.js" crossorigin="anonymous"></script>
    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.0/dist/js/bootstrap.bundle.min.js"
        crossorigin="anonymous"></script>
    <link rel="stylesheet" type="text/css"
        href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.0/dist/css/bootstrap.min.css" crossorigin="anonymous">
    <link rel="stylesheet" type="text/css"
        href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.1.2/css/fontawesome.min.css"
        crossorigin="anonymous">
    <link rel="stylesheet" type="text/css"
        href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.1.2/css/solid.css" crossorigin="anonymous">
    <link rel="stylesheet" type="text/css"
        href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.1.2/css/brands.css" crossorigin="anonymous">
    <link rel="stylesheet" type="text/css" href="styles/prettify-tomorrow.css">
    <link rel="stylesheet" type="text/css" href="styles/jaguar.css">
    <link rel="stylesheet" type="text/css" href="styles/carbon.css">
    <link rel="stylesheet" type="text/css" href="/theme/ol.css">
    <link rel="stylesheet" type="text/css" href="/theme/site.css">
</head>

<body>
    <header class="navbar navbar-expand-sm navbar-dark mb-3 px-3 py-0 fixed-top" role="navigation">
        <a class="navbar-brand" href="/"><img src="/theme/img/logo-dark.svg" width="70" height="70"
                alt="">&nbsp;OpenLayers</a>
        <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#olmenu"
            aria-controls="olmenu" aria-expanded="false" aria-label="Toggle navigation">
            <span class="navbar-toggler-icon"></span>
        </button>

        <!-- menu items that get hidden below 768px width -->
        <nav class="collapse navbar-collapse" id="olmenu">
            <ul class="nav navbar-nav ms-auto">
                <li class="nav-item dropdown">
                    <a class="nav-link dropdown-toggle" href="#" id="docdropdown" role="button"
                        data-bs-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Docs</a>
                    <div class="dropdown-menu dropdown-menu-end mb-3" aria-labelledby="docdropdown">
                        <a class="dropdown-item" href="/doc/">Docs</a>
                        <div class="dropdown-divider"></div>
                        <a class="dropdown-item" href="/doc/quickstart.html"><i
                                class="fa fa-check fa-fw me-2 fa-lg"></i>快速入门</a>
                        <a class="dropdown-item" href="/doc/faq.html"><i
                                class="fa fa-question fa-fw me-2 fa-lg"></i>FAQ</a>
                        <a class="dropdown-item" href="/doc/tutorials/"><i
                                class="fa fa-book fa-fw me-2 fa-lg"></i>Tutorials</a>
                        <div class="dropdown-divider"></div>
                        <a class="dropdown-item" href="https://stackoverflow.com/questions/tagged/openlayers"><i
                                class="fab fa-stack-overflow fa-fw me-2"></i>Ask a Question</a>
                    </div>
                </li>
                <li class="nav-item"><a class="nav-link" href="/en/latest/examples/">Examples</a></li>
                <li class="nav-item dropdown">
                    <a class="nav-link dropdown-toggle" href="#" id="apidropdown" role="button"
                        data-bs-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
                        <i class="fa fa-sitemap me-1"></i>API
                    </a>
                    <div class="dropdown-menu dropdown-menu-end mb-3" aria-labelledby="apidropdown">
                        <a class="dropdown-item" href="/en/latest/apidoc/"><i
                                class="fa fa-sitemap fa-fw me-2 fa-lg"></i>v8.2.0
                            (latest)</a </div>
                </li>
            </ul>
        </nav>
    </header>

    <div class="container-fluid">
        <div id="wrap" class="row">
            <div class="navigation col-md-4 col-lg-3">
                <div class="search-wrapper">
                    <div class="search">
                        <input id="search" type="text" autocomplete="off" class="form-control input-sm"
                            placeholder="Search Documentation">
                    </div>
                </div>
                <div class="navigation-list-wrapper">
                    <ul class="navigation-list search-empty">
                        <li class="item item-module toggle-manual toggle-manual-show" data-longname="module:ol/sphere"
                            data-name="ol/sphere">
                            <span class="title toggle">
                                <span class="fa fa-plus me-2 mt-1"></span>
                                <span><a href="module-ol_sphere.html">ol​/sphere</a></span>
                            </span>
                            <div class="member-list" data-type="typedefs">
                                <span class="subtitle">Typedefs</span>
                                <ul>
                                    <li data-name="spheremetricoptions"><a
                                            href="module-ol_sphere.html#~SphereMetricOptions">SphereMetricOptions</a>
                                </ul>
                            </div>
                            <div class="member-list" data-type="methods">
                                <span class="subtitle">Methods</span>
                                <ul>
                                    <li data-name="getarea"><a href="module-ol_sphere.html#.getArea">getArea</a>
                                    <li data-name="getdistance"><a
                                            href="module-ol_sphere.html#.getDistance">getDistance</a>
                                    <li data-name="getlength"><a href="module-ol_sphere.html#.getLength">getLength</a>
                                </ul>
                            </div>
                        <li class="loading">Loading …
                    </ul>
                </div>
            </div>

            <div class="main col-md-8 col-lg-9">
                <h1 class="page-title" data-filename="module-ol_sphere.html">Module: ol/sphere</h1>
                <div id="latest-check" class="alert alert-warning alert-dismissible" role="alert" style="display:none">
                    <button id="latest-dismiss" type="button" class="btn-close" data-bs-dismiss="alert"
                        aria-label="Close"></button>
                    This documentation is for OpenLayers v<span id="package-version">8.2.0</span>. The <a
                        id="latest-link" href="#" class="alert-link">latest</a> is v<span id="latest-version"></span>.
                </div>




                <section class="content">

                    <header>
                        <h2 class="my-3">ol/sphere
                        </h2>
                        <br>



                        <pre class="prettyprint source"><code>import * as olSphere from 'ol/sphere';</code></pre>


                        <div class="row p-3 ">
                            <!-- <div id="ad" class="col-lg-5 order-2 align-self-center border rounded bg-light ">
                                <script async type="text/javascript"
                                    src="https://cdn.carbonads.com/carbon.js?serve=CE7DV53U&placement=openlayersorg"
                                    id="_carbonads_js"></script>
                            </div> -->

                        </div>
                    </header>

                    <article>
                        <div class="container-overview">






                            <dl class="details">





















                            </dl>




                        </div>


















                        <h3 class="subsection-title">Functions</h3>

                        <dl>


                            <dt class="">

                                <div class="nameContainer">
                                    <div class="anchor" id=".getArea">
                                    </div>
                                    <h4 class="name">
                                        getArea<span class="signature">(geometry, <span
                                                class="optional">options</span>)</span><span
                                            class="fa fa-arrow-circle-right"></span><span
                                            class="type-signature returnType">{number}</span>



                                    </h4>

                                    <div class="tag-source">
                                        <a
                                            href="https://github.com/openlayers/openlayers/blob/v8.2.0/src/ol/sphere.js">sphere.js</a>,
                                        <a
                                            href="https://github.com/openlayers/openlayers/blob/v8.2.0/src/ol/sphere.js#L178">line
                                            178</a>
                                    </div>

                                </div>


                            </dt>
                            <dd class="">



                                <pre class="prettyprint source"><code>import {getArea} from 'ol/sphere';</code></pre>



                                <div class="description">
                                    <p>获取几何体的球面面积。这是面积（以米为单位）的假设，即多边形的边是球面上大圆的线段。</p>
                                </div>










                                <table class="params">
                                    <thead>
                                        <tr>

                                            <th>Name</th>


                                            <th>Type</th>

                                            <th class="last">Description</th>
                                        </tr>
                                    </thead>

                                    <tbody>


                                        <tr class="">

                                            <td class="name"><code>geometry</code></td>



                                            <td class="type">


                                                <span class="param-type"><a
                                                        href="module-ol_geom_Geometry-Geometry.html">Geometry</a></span>




                                            </td>



                                            <td class="description last">

                                                <p>A geometry.</p>
                                            </td>
                                        </tr>



                                        <tr class="">

                                            <td class="name"><code>options</code></td>




                                            <td colspan=2 class="description last">

                                                <p>面积计算的选项。默认情况下，假设几何体位于'EPSG:3857'中。您可以通过提供<code>projection</code>选项来更改此设置。
                                                </p>


                                                <table class="params">
                                                    <thead>
                                                        <tr>

                                                            <th>Name</th>


                                                            <th>Type</th>

                                                            <th class="last">Description</th>
                                                        </tr>
                                                    </thead>

                                                    <tbody>


                                                        <tr class="">

                                                            <td class="name"><code>projection</code></td>



                                                            <td class="type">


                                                                <span class="param-type"><a
                                                                        href="module-ol_proj.html#~ProjectionLike">ProjectionLike</a></span>



                                                                (defaults to 'EPSG:3857')


                                                            </td>



                                                            <td class="description last">

                                                                <p>几何体的投影。默认情况下，假设几何体采用Web Mercator投影。 </p>
                                                            </td>
                                                        </tr>



                                                        <tr class="">

                                                            <td class="name"><code>radius</code></td>



                                                            <td class="type">


                                                                <span class="param-type">number</span>



                                                                (defaults to 6371008.8)


                                                            </td>



                                                            <td class="description last">


                                                                <p>球体半径。默认情况下，使用WGS84椭球体的平均<a
                                                                        href="https://en.wikipedia.org/wiki/Earth_radius#Mean_radius">mean
                                                                        Earth radius</a>。
                                                                </p>
                                                            </td>
                                                        </tr>


                                                    </tbody>
                                                </table>
                                            </td>
                                        </tr>


                                    </tbody>
                                </table>




                                <dl class="details">





















                                </dl>















                                <h5>Returns:</h5>
                                球面面积（平方米）。
                                <br />




                            </dd>




                            <dt class="">

                                <div class="nameContainer">
                                    <div class="anchor" id=".getDistance">
                                    </div>
                                    <h4 class="name">
                                        getDistance<span class="signature">(c1, c2, <span
                                                class="optional">radius</span>)</span><span
                                            class="fa fa-arrow-circle-right"></span><span
                                            class="type-signature returnType">{number}</span>



                                    </h4>

                                    <div class="tag-source">
                                        <a
                                            href="https://github.com/openlayers/openlayers/blob/v8.2.0/src/ol/sphere.js">sphere.js</a>,
                                        <a
                                            href="https://github.com/openlayers/openlayers/blob/v8.2.0/src/ol/sphere.js#L34">line
                                            34</a>
                                    </div>

                                </div>


                            </dt>
                            <dd class="">



                                <pre
                                    class="prettyprint source"><code>import {getDistance} from 'ol/sphere';</code></pre>



                                <div class="description">
                                    <p>获取两个地理坐标之间的大圆距离（以米为单位）。</p>
                                </div>










                                <table class="params">
                                    <thead>
                                        <tr>

                                            <th>Name</th>


                                            <th>Type</th>

                                            <th class="last">Description</th>
                                        </tr>
                                    </thead>

                                    <tbody>


                                        <tr class="">

                                            <td class="name"><code>c1</code></td>



                                            <td class="type">


                                                <span class="param-type">Array</span>




                                            </td>



                                            <td class="description last">

                                                <p>起始坐标。</p>
                                            </td>
                                        </tr>



                                        <tr class="">

                                            <td class="name"><code>c2</code></td>



                                            <td class="type">


                                                <span class="param-type">Array</span>




                                            </td>



                                            <td class="description last">

                                                <p>结束坐标。</p>
                                            </td>
                                        </tr>



                                        <tr class="">

                                            <td class="name"><code>radius</code></td>



                                            <td class="type">


                                                <span class="param-type">number</span>

                                                | undefined


                                            </td>



                                            <td class="description last">

                                                <p>要使用的球体半径。默认为使用WGS84椭球体的地球平均半径。</p>
                                            </td>
                                        </tr>


                                    </tbody>
                                </table>




                                <dl class="details">





















                                </dl>















                                <h5>Returns:</h5>
                                点之间的大圆距离（以米为单位）。
                                <br />




                            </dd>




                            <dt class="">

                                <div class="nameContainer">
                                    <div class="anchor" id=".getLength">
                                    </div>
                                    <h4 class="name">
                                        getLength<span class="signature">(geometry, <span
                                                class="optional">options</span>)</span><span
                                            class="fa fa-arrow-circle-right"></span><span
                                            class="type-signature returnType">{number}</span>



                                    </h4>

                                    <div class="tag-source">
                                        <a
                                            href="https://github.com/openlayers/openlayers/blob/v8.2.0/src/ol/sphere.js">sphere.js</a>,
                                        <a
                                            href="https://github.com/openlayers/openlayers/blob/v8.2.0/src/ol/sphere.js#L75">line
                                            75</a>
                                    </div>

                                </div>


                            </dt>
                            <dd class="">



                                <pre class="prettyprint source"><code>import {getLength} from 'ol/sphere';</code></pre>



                                <div class="description">
                                    <p>获取几何体的球面长度。该长度是坐标间大圆距离的总和。对于多边形，长度是所有环的总和。对于点，长度为零。对于多部分几何体，长度是每个部分长度的总和。</p>
                                </div>










                                <table class="params">
                                    <thead>
                                        <tr>

                                            <th>Name</th>


                                            <th>Type</th>

                                            <th class="last">Description</th>
                                        </tr>
                                    </thead>

                                    <tbody>


                                        <tr class="">

                                            <td class="name"><code>geometry</code></td>



                                            <td class="type">


                                                <span class="param-type"><a
                                                        href="module-ol_geom_Geometry-Geometry.html">Geometry</a></span>




                                            </td>



                                            <td class="description last">

                                                <p>A geometry.</p>
                                            </td>
                                        </tr>



                                        <tr class="">

                                            <td class="name"><code>options</code></td>




                                            <td colspan=2 class="description last">

                                                <p>长度计算的选项。默认情况下，假设几何体位于'EPSG:3857'中。您可以通过提供<code>projection</code>选项来更改此设置。
                                                </p>


                                                <table class="params">
                                                    <thead>
                                                        <tr>

                                                            <th>Name</th>


                                                            <th>Type</th>

                                                            <th class="last">Description</th>
                                                        </tr>
                                                    </thead>

                                                    <tbody>


                                                        <tr class="">

                                                            <td class="name"><code>projection</code></td>



                                                            <td class="type">


                                                                <span class="param-type"><a
                                                                        href="module-ol_proj.html#~ProjectionLike">ProjectionLike</a></span>



                                                                (defaults to 'EPSG:3857')


                                                            </td>



                                                            <td class="description last">

                                                                <p>几何体的投影。默认情况下，假设几何体采用Web Mercator投影。 </p>
                                                            </td>
                                                        </tr>



                                                        <tr class="">

                                                            <td class="name"><code>radius</code></td>



                                                            <td class="type">


                                                                <span class="param-type">number</span>



                                                                (defaults to 6371008.8)


                                                            </td>



                                                            <td class="description last">

                                                                <p>球体半径。默认情况下，使用WGS84椭球体的平均<a
                                                                        href="https://en.wikipedia.org/wiki/Earth_radius#Mean_radius">mean
                                                                        Earth radius</a>。
                                                                </p>
                                                            </td>
                                                        </tr>


                                                    </tbody>
                                                </table>
                                            </td>
                                        </tr>


                                    </tbody>
                                </table>




                                <dl class="details">





















                                </dl>















                                <h5>Returns:</h5>
                                The spherical length (in meters).
                                <br />




                            </dd>

                        </dl>



                        <h3 class="subsection-title">Type Definitions</h3>

                        <dl>

                            <dt class="">
                                <div class="nameContainer">
                                    <div class="anchor" id="~SphereMetricOptions">
                                    </div>
                                    <h4 class="name">
                                        SphereMetricOptions<span class="type-signature type object">{Object}</span>


                                    </h4>
                                </div>

                            </dt>
                            <dd class="">

                                <div class="description">
                                    <p>用于<code>getLength</code> or
                                        <code>getArea</code>
                                        函数的选项的对象文字。
                                    </p>
                                </div>



                                <dl class="details">


                                    <h5 class="subsection-title">Properties:</h5>

                                    <dl>

                                        <table class="props">
                                            <thead>
                                                <tr>

                                                    <th>Name</th>


                                                    <th>Type</th>

                                                    <th class="last">Description</th>
                                                </tr>
                                            </thead>

                                            <tbody>


                                                <tr>

                                                    <td class="name"><code>projection</code></td>


                                                    <td class="type">


                                                        <span class="param-type"><a
                                                                href="module-ol_proj.html#~ProjectionLike">ProjectionLike</a></span>



                                                        <br>(defaults to 'EPSG:3857')


                                                    </td>

                                                    <td class="description last">
                                                        <p>几何体的投影。默认情况下，假设几何体采用Web Mercator投影。</p>

                                                    </td>
                                                </tr>



                                                <tr>

                                                    <td class="name"><code>radius</code></td>


                                                    <td class="type">


                                                        <span class="param-type">number</span>



                                                        <br>(defaults to 6371008.8)


                                                    </td>

                                                    <td class="description last">
                                                        <p>球体半径。默认为使用WGS84椭球体的 <a
                                                                href="https://en.wikipedia.org/wiki/Earth_radius#Mean_radius">地球平均半径(mean
                                                                Earth radius)</a>。

                                                        </p>

                                                    </td>
                                                </tr>


                                            </tbody>
                                        </table>
                                    </dl>






















                                </dl>



                            </dd>

                        </dl>



                    </article>

                </section>




            </div>
        </div>
    </div>
    <script>prettyPrint();</script>
    <script src="scripts/linenumber.js"></script>
    <script src="scripts/main.js"></script>
</body>

</html>